/*
 * Copyright (C) 2009 M. Hautle.
 * 
 * This file is part of TrackedBean.
 * 
 * TrackedBean is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation, either version 3 of the License, or (at your option) any later version.
 * 
 * TrackedBean is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License along with TrackedBean. If not, see <http://www.gnu.org/licenses/>.
 */
package ch.trackedbean.tracking;

/**
 * The status of a property/bean
 * 
 * @author M. Hautle
 */
public final class Status {
    /** The flag describing the status of the element */
    private final BeanStatusFlag flag;

    /** An message describing the reason for the status or null */
    private final String message;

    /**
     * Default constructor
     * 
     * @param flag The status flag
     */
    public Status(final BeanStatusFlag flag) {
        this(flag, null);
    }

    /**
     * Default constructor
     * 
     * @param flag The status flag
     * @param message The status message
     */
    public Status(final BeanStatusFlag flag, final String message) {
        this.flag = flag;
        this.message = message;
    }

    /**
     * @return the flag
     */
    public BeanStatusFlag getFlag() {
        return flag;
    }

    /**
     * @return the message
     */
    public String getMessage() {
        return message;
    }

    /**
     * Checks if the given flag and message are identical with the content of this Statusobject
     * 
     * @param flag A status flag
     * @param message A message
     * @return True if the given flag and message are identical with the content of this Statusobject
     */
    public boolean equals(final BeanStatusFlag flag, final String message) {
        return this.flag == flag && (this.message == message || this.message != null && this.message.equals(message));
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean equals(final Object obj) {
        if (!(obj instanceof Status))
            return false;
        final Status o = (Status) obj;
        return flag == o.flag && (o.message == message || message != null && message.equals(o.message));
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String toString() {
        if (message == null)
            return flag.toString();
        return flag.toString() + ": " + message;
    }
}